Skip to content

docs: use fluent tool builder syntax in README #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom
Merged
0xeb merged 1 commit into from
Jan 30, 2026
Merged

docs: use fluent tool builder syntax in README #6

0xeb merged 1 commit into from
Jan 30, 2026

Conversation

@0xeb
Copy link
Owner

@0xeb 0xeb commented Jan 30, 2026

Summary

  • Replace verbose JSON schema construction with cleaner fluent API examples
  • Lead with ToolBuilder for full control, then make_tool() for quick one-liners
  • Auto-generated JSON schemas from C++ types - no more manual JSON!

Before

calc_tool.parameters_schema = copilot::json{
    {"type", "object"},
    {"properties", {{"expression", {{"type", "string"}}}}},
    {"required", {"expression"}}
};

After

auto calc = copilot::ToolBuilder("calculator", "Perform math calculations")
    .param<std::string>("expression", "Math expression to evaluate")
    .handler([](std::string expression) { return "42"; });

Test plan

  • README snippets verified to compile and run

@0xeb
docs: use fluent tool builder syntax in README
a16cb53 
Replace verbose JSON schema construction with cleaner fluent API:
- ToolBuilder with .param<T>() for type-safe parameters
- make_tool() for quick one-liners
- Auto-generated JSON schemas from C++ types

Also add tests/.gitignore for byok.env (API keys)
@0xeb 0xeb merged commit a3565bd into main Jan 30, 2026
3 checks passed
@0xeb 0xeb deleted the docs/fluent-tool-readme branch January 30, 2026 22:02
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

No reviews

Assignees

No one assigned

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

1 participant

@0xeb